home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / SCSL / sggbal.z / sggbal
Encoding:
Text File  |  2002-10-03  |  5.8 KB  |  199 lines

  1.  
  2.  
  3.  
  4. SSSSGGGGGGGGBBBBAAAALLLL((((3333SSSS))))                                                          SSSSGGGGGGGGBBBBAAAALLLL((((3333SSSS))))
  5.  
  6.  
  7.  
  8. NNNNAAAAMMMMEEEE
  9.      SGGBAL - balance a pair of general real matrices (A,B)
  10.  
  11. SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.      SUBROUTINE SGGBAL( JOB, N, A, LDA, B, LDB, ILO, IHI, LSCALE, RSCALE,
  13.                         WORK, INFO )
  14.  
  15.          CHARACTER      JOB
  16.  
  17.          INTEGER        IHI, ILO, INFO, LDA, LDB, N
  18.  
  19.          REAL           A( LDA, * ), B( LDB, * ), LSCALE( * ), RSCALE( * ),
  20.                         WORK( * )
  21.  
  22. IIIIMMMMPPPPLLLLEEEEMMMMEEEENNNNTTTTAAAATTTTIIIIOOOONNNN
  23.      These routines are part of the SCSL Scientific Library and can be loaded
  24.      using either the -lscs or the -lscs_mp option.  The -lscs_mp option
  25.      directs the linker to use the multi-processor version of the library.
  26.  
  27.      When linking to SCSL with -lscs or -lscs_mp, the default integer size is
  28.      4 bytes (32 bits). Another version of SCSL is available in which integers
  29.      are 8 bytes (64 bits).  This version allows the user access to larger
  30.      memory sizes and helps when porting legacy Cray codes.  It can be loaded
  31.      by using the -lscs_i8 option or the -lscs_i8_mp option. A program may use
  32.      only one of the two versions; 4-byte integer and 8-byte integer library
  33.      calls cannot be mixed.
  34.  
  35. PPPPUUUURRRRPPPPOOOOSSSSEEEE
  36.      SGGBAL balances a pair of general real matrices (A,B). This involves,
  37.      first, permuting A and B by similarity transformations to isolate
  38.      eigenvalues in the first 1 to ILO$-$1 and last IHI+1 to N elements on the
  39.      diagonal; and second, applying a diagonal similarity transformation to
  40.      rows and columns ILO to IHI to make the rows and columns as close in norm
  41.      as possible. Both steps are optional.
  42.  
  43.      Balancing may reduce the 1-norm of the matrices, and improve the accuracy
  44.      of the computed eigenvalues and/or eigenvectors in the generalized
  45.      eigenvalue problem A*x = lambda*B*x.
  46.  
  47.  
  48. AAAARRRRGGGGUUUUMMMMEEEENNNNTTTTSSSS
  49.      JOB     (input) CHARACTER*1
  50.              Specifies the operations to be performed on A and B:
  51.              = 'N':  none:  simply set ILO = 1, IHI = N, LSCALE(I) = 1.0 and
  52.              RSCALE(I) = 1.0 for i = 1,...,N.  = 'P':  permute only;
  53.              = 'S':  scale only;
  54.              = 'B':  both permute and scale.
  55.  
  56.      N       (input) INTEGER
  57.              The order of the matrices A and B.  N >= 0.
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. SSSSGGGGGGGGBBBBAAAALLLL((((3333SSSS))))                                                          SSSSGGGGGGGGBBBBAAAALLLL((((3333SSSS))))
  71.  
  72.  
  73.  
  74.      A       (input/output) REAL array, dimension (LDA,N)
  75.              On entry, the input matrix A.  On exit,  A is overwritten by the
  76.              balanced matrix.  If JOB = 'N', A is not referenced.
  77.  
  78.      LDA     (input) INTEGER
  79.              The leading dimension of the array A. LDA >= max(1,N).
  80.  
  81.      B       (input/output) REAL array, dimension (LDB,N)
  82.              On entry, the input matrix B.  On exit,  B is overwritten by the
  83.              balanced matrix.  If JOB = 'N', B is not referenced.
  84.  
  85.      LDB     (input) INTEGER
  86.              The leading dimension of the array B. LDB >= max(1,N).
  87.  
  88.      ILO     (output) INTEGER
  89.              IHI     (output) INTEGER ILO and IHI are set to integers such
  90.              that on exit A(i,j) = 0 and B(i,j) = 0 if i > j and j =
  91.              1,...,ILO-1 or i = IHI+1,...,N.  If JOB = 'N' or 'S', ILO = 1 and
  92.              IHI = N.
  93.  
  94.      LSCALE  (output) REAL array, dimension (N)
  95.              Details of the permutations and scaling factors applied to the
  96.              left side of A and B.  If P(j) is the index of the row
  97.              interchanged with row j, and D(j) is the scaling factor applied
  98.              to row j, then LSCALE(j) = P(j)    for J = 1,...,ILO-1 = D(j)
  99.              for J = ILO,...,IHI = P(j)    for J = IHI+1,...,N.  The order in
  100.              which the interchanges are made is N to IHI+1, then 1 to ILO-1.
  101.  
  102.      RSCALE  (output) REAL array, dimension (N)
  103.              Details of the permutations and scaling factors applied to the
  104.              right side of A and B.  If P(j) is the index of the column
  105.              interchanged with column j, and D(j) is the scaling factor
  106.              applied to column j, then LSCALE(j) = P(j)    for J = 1,...,ILO-1
  107.              = D(j)    for J = ILO,...,IHI = P(j)    for J = IHI+1,...,N.  The
  108.              order in which the interchanges are made is N to IHI+1, then 1 to
  109.              ILO-1.
  110.  
  111.      WORK    (workspace) REAL array, dimension (6*N)
  112.  
  113.      INFO    (output) INTEGER
  114.              = 0:  successful exit
  115.              < 0:  if INFO = -i, the i-th argument had an illegal value.
  116.  
  117. FFFFUUUURRRRTTTTHHHHEEEERRRR DDDDEEEETTTTAAAAIIIILLLLSSSS
  118.      See R.C. WARD, Balancing the generalized eigenvalue problem,
  119.                     SIAM J. Sci. Stat. Comp. 2 (1981), 141-152.
  120.  
  121.  
  122. SSSSEEEEEEEE AAAALLLLSSSSOOOO
  123.      INTRO_LAPACK(3S), INTRO_SCSL(3S)
  124.  
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. SSSSGGGGGGGGBBBBAAAALLLL((((3333SSSS))))                                                          SSSSGGGGGGGGBBBBAAAALLLL((((3333SSSS))))
  137.  
  138.  
  139.  
  140.      This man page is available only online.
  141.  
  142.  
  143.  
  144.  
  145.  
  146.  
  147.  
  148.  
  149.  
  150.  
  151.  
  152.  
  153.  
  154.  
  155.  
  156.  
  157.  
  158.  
  159.  
  160.  
  161.  
  162.  
  163.  
  164.  
  165.  
  166.  
  167.  
  168.  
  169.  
  170.  
  171.  
  172.  
  173.  
  174.  
  175.  
  176.  
  177.  
  178.  
  179.  
  180.  
  181.  
  182.  
  183.  
  184.  
  185.  
  186.  
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.